home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 12 / BBS in a box XII-2.iso / Files II / Prog / D-G / Extension Shell 1.3.sit / Extension Shell 1.3 ƒ / Extension Shell 1.3 (Source) / InstallCode.c / InstallCode.c
Encoding:
Text File  |  1994-04-06  |  12.0 KB  |  498 lines  |  [TEXT/R*ch]
  1. /*    NAME:
  2.         InstallCode.c
  3.  
  4.     WRITTEN BY:
  5.         Dair Grant
  6.                 
  7.     DESCRIPTION:
  8.         Routines for installing the various code resources Extension Shell supports.
  9.  
  10.     ___________________________________________________________________________
  11.  
  12.     VERSION HISTORY:
  13.         (Jan 1994, dg)
  14.             •    Added low-memory filter support.
  15.  
  16.         (Jan 1994, dg)
  17.             •    First publicly distributed version.
  18.  
  19.         (Mar 1994, dg)
  20.             •    Added support for code blocks.
  21.             
  22.             
  23.     ___________________________________________________________________________
  24. */
  25. //=============================================================================
  26. //        Include files                                                                     
  27. //-----------------------------------------------------------------------------
  28. #include <GestaltEqu.h>
  29. #include <Shutdown.h>
  30. #include "ParamBlock.h"
  31. #include "InstallCode.h"
  32. #include "ExtensionShell.h"
  33. #include "AddrsTable.h"
  34.  
  35.  
  36.  
  37.  
  38.  
  39. //=============================================================================
  40. //        Private function prototypes                                                                     
  41. //-----------------------------------------------------------------------------
  42. OSErr    InstallTrapPatch(short i, Ptr theCode);
  43. OSErr    InstallGestaltSelector(short i, Ptr theCode);
  44. OSErr    InstallShutdownTask(short i, Ptr theCode);
  45. OSErr    InstallVBLTask(short i, Ptr theCode);
  46. OSErr    InstallLowMemFilter(short i, Ptr theCode);
  47. OSErr    InstallCodeBlock(short i, Ptr theCode);
  48. OSErr    InstallTimeManagerTask(short i, Ptr theCode);
  49.  
  50.  
  51.  
  52.  
  53.  
  54. //=============================================================================
  55. //        Global variables                                                                 
  56. //-----------------------------------------------------------------------------
  57. extern ESParamBlock        gTheParamBlock;
  58. extern AddressTable        *gTheAddressTable;
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. //=============================================================================
  70. //        InstallCode : Install a code resource depending on its type.                                                                 
  71. //-----------------------------------------------------------------------------
  72. //        Note :    We get the index of something in gTheParamBlock.TheCodeResources
  73. //                and case out on its type to do the installation. Both ourselves
  74. //                and the actual install routines are only expected to return any
  75. //                error code that arises. If an error does occur, our caller
  76. //                looks after filling in the other error details in gTheParamBlock.
  77. //-----------------------------------------------------------------------------
  78. OSErr InstallCode(short i)
  79. {    Handle        theHnd;
  80.     OSErr        theErr;
  81.     Ptr            theCode;
  82.     int            theType;
  83.     
  84.     
  85.  
  86.  
  87.     // Get the code resource in question, and abort if it wasn't there.
  88.     theHnd = GetResource(gTheParamBlock.theCodeResources[i].resType,
  89.                          gTheParamBlock.theCodeResources[i].resID);
  90.     if (theHnd == nil)
  91.         return(resNotFound);
  92.  
  93.  
  94.     
  95.     // Unlock, move high, and lock the resource. Then detach it so
  96.     // it stays around after Extension Shell is gone.
  97.     HUnlock(theHnd);
  98.     HLockHi(theHnd);
  99.     DetachResource(theHnd);
  100.  
  101.  
  102.  
  103.     // Get a clean address from the handle
  104.     theCode = (Ptr) StripAddress(*theHnd);
  105.  
  106.  
  107.  
  108.     // Now case out on the type of the code, and call the install routine
  109.     switch(gTheParamBlock.theCodeResources[i].codeType) {
  110.         case kTrapPatchType:
  111.              theErr = InstallTrapPatch(i, theCode);
  112.              break;
  113.              
  114.         case kGestaltSelectorType:
  115.              theErr = InstallGestaltSelector(i, theCode);
  116.              break;
  117.              
  118.         case kShutdownTaskType:
  119.              theErr = InstallShutdownTask(i, theCode);
  120.              break;
  121.              
  122.         case kVBLTaskType:
  123.              theErr = InstallVBLTask(i, theCode);
  124.              break;
  125.         
  126.         case kLowMemFilterType:
  127.              theErr = InstallLowMemFilter(i, theCode);
  128.              break;
  129.         
  130.         case kCodeBlockType:
  131.              theErr = InstallCodeBlock(i, theCode);
  132.              break;
  133.         
  134.         case kTimeManagerTaskType:
  135.              theErr = InstallTimeManagerTask(i, theCode);
  136.              break;
  137.         
  138.         default:
  139.              theErr = noErr;
  140.     }
  141.  
  142.     
  143.     
  144.     return(theErr);
  145. } 
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156. //=============================================================================
  157. //        InstallAddressTable : Install an address table for the INIT.
  158. //-----------------------------------------------------------------------------
  159. //        Note :    We install the Gestalt selector, get a hold of the address
  160. //                table and leave the address of the table in the global
  161. //                gTheAddressTable.
  162. //-----------------------------------------------------------------------------
  163. void InstallAddressTable(void)
  164. {    Handle            theHnd;
  165.     OSErr            theErr;
  166.     
  167.  
  168.  
  169.  
  170.     // Load the AddressTable Gestalt selector, and install it with NewGestalt.
  171.     // If we can't get it, we die.
  172.     theHnd = GetResource(kAddrsTableCodeType, kAddrsTableCodeID);
  173.     if (theHnd == nil)
  174.         DebugStr("\pExtension Shell - couldn't find AddressTable CODE resource");
  175.     
  176.         
  177.     
  178.     // We have it, so prepare the code by detaching it and locking it high
  179.     HUnlock(theHnd);
  180.     HLockHi(theHnd);
  181.     DetachResource(theHnd);
  182.     
  183.     
  184.     
  185.     // Install it as a Gestalt selector
  186.     theErr = NewGestalt(gTheParamBlock.addressTableSelector, (ProcPtr) *theHnd);
  187.     if (theErr != noErr)
  188.         DebugStr("\pExtension Shell - couldn't install AddressTable");
  189.         
  190.  
  191.  
  192.     // Call the new routine to get the address of the address table
  193.     theErr = Gestalt(gTheParamBlock.addressTableSelector, &gTheAddressTable);
  194.     if (theErr != noErr)
  195.         DebugStr("\pExtension Shell - couldn't call AddressTable");
  196. }
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207. //=============================================================================
  208. //        InstallTrapPatch : Install a trap patch.                                                         
  209. //-----------------------------------------------------------------------------
  210. //        Note :    Given a trap number and a pointer to the new routine, we save
  211. //                the original entry in the dispatch table and insert ours.
  212. //
  213. //                We assume that the trap *is* implemented.
  214. //-----------------------------------------------------------------------------
  215. OSErr InstallTrapPatch(short i, Ptr theCode)
  216. {    OSErr        theErr;
  217.     int            trapNum;
  218.     TrapType    tType;
  219.     ProcPtr        oldCodeAddress;
  220.     
  221.     
  222.     
  223.     
  224.      // Copy the relevent details into local variables for speed
  225.      trapNum            = gTheParamBlock.theCodeResources[i].theCodeThing.theTrapPatch.trapNum;
  226.  
  227.  
  228.  
  229.      // Get the type of the trap
  230.     tType = GetTrapType(trapNum);
  231.     
  232.     
  233.     
  234.     // Replace the old value in the dispatch table with the new value.
  235.     oldCodeAddress = (ProcPtr) StripAddress((Ptr) NGetTrapAddress(trapNum, tType));
  236.     NSetTrapAddress((long) theCode, trapNum, tType);
  237.     theErr = noErr;
  238.     
  239.     
  240.     
  241.     // If there wasn't a problem, fill in the entry in the address table
  242.     // and save the address of the new code.
  243.     if (theErr == noErr)
  244.         {
  245.         gTheAddressTable->theTable[i]                    = oldCodeAddress;
  246.         gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  247.         }
  248.     
  249.     
  250.     
  251.     // If there was a problem, return it
  252.     return(theErr);    
  253. }
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264. //=============================================================================
  265. //        InstallGestaltSelector : Install a Gestalt Selector.                                                         
  266. //-----------------------------------------------------------------------------
  267. OSErr InstallGestaltSelector(short i, Ptr theCode)
  268. {    OSErr                theErr;
  269.     AGestaltSelector    *theGestaltInfo;
  270.  
  271.  
  272.  
  273.  
  274.     // Get a pointer to the information to save on dereferences
  275.     theGestaltInfo = &gTheParamBlock.theCodeResources[i].theCodeThing.theGestaltSelector;
  276.     
  277.     
  278.     
  279.     // Try and install the routine
  280.     theErr = NewGestalt(theGestaltInfo->theSelector, (ProcPtr) theCode);
  281.     
  282.     
  283.     
  284.     // If the selector exists, replace it if we're allowed to, and save
  285.     // the address of the old routine in the address table
  286.     if (theErr == gestaltDupSelectorErr && theGestaltInfo->overwriteExistingSelector)
  287.         theErr = ReplaceGestalt(theGestaltInfo->theSelector,
  288.                                 theCode,
  289.                                 &gTheAddressTable->theTable[i]);
  290.     
  291.     
  292.     
  293.     // If there wasn't a problem, save the address of the new code. The address
  294.     // table is only used if we need to get access to the old Gestalt routine.
  295.     if (theErr == noErr)
  296.         gTheParamBlock.theCodeResources[i].theAddress = theCode;
  297.         
  298.         
  299.     
  300.     // If there was a problem, return it
  301.     return(theErr);
  302. }
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313. //=============================================================================
  314. //        InstallShutdownTask : Install a Shutdown Task.                                                         
  315. //-----------------------------------------------------------------------------
  316. OSErr InstallShutdownTask(short i, Ptr theCode)
  317. {    OSErr    theErr;
  318.  
  319.  
  320.  
  321.  
  322.     // Install the task with its flags. We assume no errors can occur.
  323.     ShutDwnInstall((ShutDwnProcPtr) theCode,
  324.                    gTheParamBlock.theCodeResources[i].theCodeThing.theShutdownTask.theFlags);
  325.     theErr = noErr;    
  326.     
  327.     
  328.     
  329.     // Save the address in gTheParamBlock. We don't use the address table at all.
  330.     if (theErr == noErr)
  331.         gTheParamBlock.theCodeResources[i].theAddress = theCode;
  332.  
  333.  
  334.  
  335.     // If there was a problem, return it
  336.     return(theErr);
  337. }
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348. //=============================================================================
  349. //        InstallVBLTask : Install a VBL task.                                                         
  350. //-----------------------------------------------------------------------------
  351. OSErr InstallVBLTask(short i, Ptr theCode)
  352. {    VBLTask         *theVblPtr;
  353.     OSErr            theErr;
  354.     
  355.     
  356.     
  357.     
  358.     // Allocate a little block of memory in the System Heap for the task information
  359.     theVblPtr = (VBLTask*) NewPtrSys(sizeof(VBLTask));
  360.     
  361.     
  362.     
  363.     // Fill in the fields, and install it as a VBL task
  364.     theVblPtr->qType    = vType;
  365.     theVblPtr->vblAddr  = (VBLProcPtr) theCode;
  366.     theVblPtr->vblCount = gTheParamBlock.theCodeResources[i].theCodeThing.theVBLTask.vblCount;
  367.     theVblPtr->vblPhase = gTheParamBlock.theCodeResources[i].theCodeThing.theVBLTask.vblPhase;
  368.     theErr = VInstall(theVblPtr);
  369.     
  370.     
  371.     
  372.     // Save the address of the VBLTask structure in the address table and the param block
  373.     if (theErr == noErr)
  374.         {
  375.         gTheAddressTable->theTable[i]                    = (ProcPtr) theVblPtr;
  376.         gTheParamBlock.theCodeResources[i].theAddress    = (Ptr) theVblPtr;
  377.         }
  378.     
  379.     
  380.     // If there was a problem, return it
  381.     return(theErr);
  382. }
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393. //=============================================================================
  394. //        InstallLowMemFilter : Install a low-memory filter.                                                         
  395. //-----------------------------------------------------------------------------
  396. OSErr InstallLowMemFilter(short i, Ptr theCode)
  397. {    ProcPtr        theEntryPoint;
  398.     
  399.  
  400.  
  401.     
  402.     // Get the address of the filter chain.
  403.     theEntryPoint = (ProcPtr) gTheParamBlock.theCodeResources[i].theCodeThing.theLowMemFilter.theEntryPoint;
  404.     
  405.     
  406.     
  407.     // Save the address currently at the front of the chain in the address table
  408.     // and save ourselves in the param block.
  409.     gTheAddressTable->theTable[i]                    = (ProcPtr) *((void **) theEntryPoint);
  410.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  411.     
  412.     
  413.     
  414.     // Insert ourselves into the front of the chain
  415.     *((long *) theEntryPoint) = (long) theCode;
  416.  
  417.  
  418.  
  419.     // If there was a problem, return it
  420.     return(noErr);
  421. }
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432. //=============================================================================
  433. //        InstallCodeBlock : Install a block of code.                                                         
  434. //-----------------------------------------------------------------------------
  435. OSErr InstallCodeBlock(short i, Ptr theCode)
  436. {    ProcPtr        theEntryPoint;
  437.     
  438.     
  439.  
  440.     
  441.     // Set the reserved field to some value
  442.     gTheParamBlock.theCodeResources[i].theCodeThing.theCodeBlock.reserved = 0x0000;
  443.     
  444.     
  445.     
  446.     // Save the address of the code block in the address table and the param block
  447.     gTheAddressTable->theTable[i]                    = (ProcPtr) theCode;
  448.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  449.  
  450.  
  451.  
  452.     // If there was a problem, return it
  453.     return(noErr);
  454. }
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465. //=============================================================================
  466. //        InstallTimeManagerTask : Install a Time Manager task.                                                         
  467. //-----------------------------------------------------------------------------
  468. OSErr InstallTimeManagerTask(short i, Ptr theCode)
  469. {    TMTask             *theTaskPtr;
  470.  
  471.  
  472.  
  473.  
  474.     // Allocate a little block of memory in the System Heap for the task information
  475.     theTaskPtr = (TMTask*) NewPtrSys(sizeof(TMTask));
  476.     
  477.     
  478.     
  479.     // Fill in the fields, and install it as an Time Manager task. We don't install
  480.     // it as with InsXTime because we probably won't need that accurate timing.
  481.     theTaskPtr->tmAddr    = (ProcPtr) theCode;
  482.     theTaskPtr->tmCount    = 0;
  483.     InsTime(theTaskPtr);
  484.     PrimeTime(theTaskPtr,
  485.                 gTheParamBlock.theCodeResources[i].theCodeThing.theTimeManagerTask.theDelay);
  486.     
  487.     
  488.     
  489.     // Save the address of the TMTask structure in the address table and the param block
  490.     gTheAddressTable->theTable[i]                    = (ProcPtr) theTaskPtr;
  491.     gTheParamBlock.theCodeResources[i].theAddress    = (Ptr) theTaskPtr;
  492.     
  493.     
  494.     
  495.     // Return no errors
  496.     return(noErr);
  497. }
  498.